Skip to content

docs(tokens): add cross-links to ERC-6909 and ERC-4626 #6150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ANtutov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(tokens): add cross-links to ERC-6909 and ERC-4626 #6150

ANtutov wants to merge 1 commit into from

Conversation

@ANtutov
Copy link

@ANtutov ANtutov commented Nov 27, 2025

Updated the tokens overview to include cross-links for ERC-6909 and ERC-4626, which are already present in the codebase and documentation. Adding these references improves discoverability and completeness of the standards overview: ERC-6909 provides a minimal multi-token model aligned with account-based balances in this repo under contracts/token/ERC6909/, and ERC-4626 formalizes tokenized vaults which are commonly used with ERC-20 for yield-bearing strategies and is documented alongside existing token topics. These links keep the overview consistent with current library coverage and help readers navigate to modern token standards beyond ERC-20/721/1155.

@ANtutov ANtutov requested a review from a team as a code owner November 27, 2025 08:52
@changeset-bot
Copy link

changeset-bot bot commented Nov 27, 2025

⚠️ No Changeset found

Latest commit: 36f6fdc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2025

Walkthrough

The documentation file tokens.adoc has been updated to include two additional ERC standard references in its list. ERC-6909, a minimal multi-token standard featuring account-based balances, and ERC-4626, a tokenized vault standard for yield-bearing assets, have been added as new bullet points. These additions expand the coverage of documented standards without modifying any existing content or removing any prior references.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding cross-links to ERC-6909 and ERC-4626 in the tokens documentation.
Description check ✅ Passed The description is directly related to the changeset, providing context about why ERC-6909 and ERC-4626 are being added to the tokens overview and explaining their purpose and existing presence in the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03666bd and 36f6fdc.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/tokens.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
  • GitHub Check: slither
  • GitHub Check: tests
  • GitHub Check: coverage
  • GitHub Check: tests-foundry
  • GitHub Check: tests-upgradeable
  • GitHub Check: halmos
🔇 Additional comments (2)
docs/modules/ROOT/pages/tokens.adoc (2)

29-33: Documentation additions follow established style and conventions.

The new cross-links to ERC-6909 and ERC-4626 follow the same format and style as the existing ERC standards references. The descriptions are concise and accurate. Once the referenced documentation files are verified to exist, these additions will improve discoverability of the complete set of supported token standards.

32-33: Unable to verify file existence due to repository access limitations.

The verification process cannot be completed because the repository cannot be cloned and GitHub API queries are unavailable in this environment. The concern raised in the original review comment—whether erc6909.adoc and erc4626.adoc documentation files actually exist—remains unresolved.

To complete this verification, you will need to manually check:

  1. Whether the files docs/modules/ROOT/pages/erc6909.adoc and docs/modules/ROOT/pages/erc4626.adoc exist in the repository
  2. Whether the xref links in lines 32-33 of docs/modules/ROOT/pages/tokens.adoc resolve correctly

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ANtutov